home *** CD-ROM | disk | FTP | other *** search
/ SPACE 2 / SPACE - Library 2 - Volume 1.iso / utility / 557 / dbackup / dbackup.man next >
Text File  |  1991-10-19  |  11KB  |  199 lines
  1. NAME
  2.     dbackup - a backup program for people with removable hard disks
  3.  
  4. SYNOPSIS
  5.     dbackup [options] [source] [destination]
  6.     dbackup [-fhktv]  [-[o|x] <suffixes>]             [source] <destination>
  7.     dbackup [-l <format>] [-fhv] [-[o|x] <suffixes>]  [source]
  8.     dbackup [-a <utility> <line>] [-r <size>] [-fhkv] [source] <destination>
  9.     dbackup [-[c|s|m]fhv] [-[o|x] <suffixes>]         [source]
  10.  
  11. DESCRIPTION
  12.     dbackup is a program primarily targetted at people who have relatively
  13.     large removable medias. Normally, a backup program is often dedicated for
  14.     a specific removable media which, in face of evolution, at some time from
  15.     the point of design and creation cannot support a new media. What I'm
  16.     particulary refering to is, of course, backup programs relying totally on
  17.     floppy disks. Since this was one of the objectives with this project, I
  18.     have tried to eliminate any such dependencies and it should work on any
  19.     media that I know of. It has been tried with mixes of hard disks,
  20.     floppies, and a 10 Mbyte removable floppy disk unit (a Supra FD-10 based
  21.     on a Konica mechanism). In respect with this specification, this program
  22.     now have many similarites to simple copy statements found in most shells
  23.     and command line interpreters, indeed it does work best if called from
  24.     such an environment, but it may be used from the GEM desktop without
  25.     problems.
  26.  
  27.     As seen above in the synopsis there is 4 versions of the command line,
  28.     each of which is a derivate of the first general synopsis. The 4 versions
  29.     are shown since, depending upon which options are chosen, some arguments 
  30.     are required to be specified, most notably the requirement of the {source} 
  31.     and {destination} arguments wary. It should also be noted that limited 
  32.     checking is performed on the mixes of options - so care should be taken 
  33.     not to specify contradictory options.
  34.  
  35.     In the synopsis {source} specify where the directories and files to backup
  36.     are located and {destination} specify where files, which match backup
  37.     criteria, are to be copied to. If copying is to be done, during a backup
  38.     session, a check is always made to ensure that neither of these arguments
  39.     are equal as well as throughout the session. This means that {destination}
  40.     may be a sub-directory of the {source} directory and that this program
  41.     will not hang due to an endless copying loop.
  42.  
  43.     The default mode of this program is incremental backup, ie. only files
  44.     which has been written match backup criteria. For this purpose the state
  45.     of the "archive" flag is checked upon and if set files are copied. A flag
  46.     is also available if a full backup is desired.
  47.  
  48. OPTIONS
  49.     -a
  50.         backup files via an archive utility (see ARCHIVE UTILITIES)
  51.         This option also needs two additional arguments, {utility, line}:
  52.         utility     is the filename of the archive utility to be used
  53.         line        is the format of the command line
  54.     -c
  55.         clear archive flag status on all files without copying files.
  56.         It does not need a {destination} argument.
  57.     -h
  58.         hold screen after backup, Primarily useful when called from the GEM
  59.         desktop.
  60.     -f  full backup, ignores the archive flag and copies everything
  61.     -k  keep archive flag status on source files
  62.     -l
  63.         A list is produced of files to backup. The list format is specified
  64.         using the compulsory {format} (see LIST FORMAT) argument. The list is
  65.         sent to a file in the current working directory, called "dbackup.xxx".
  66.         It does not need a {destination} argument.
  67.     -m
  68.         mark files for backup (ie. set archive flag on all files)
  69.         It does not need a {destination} argument.
  70.     -o
  71.         copy only files which have any of the defined suffixes. The suffixes
  72.         to be copied is specified by {suffixes}. If the list is started with a
  73.         dot ("."), files which do not have a suffix is also copied. Suffixes
  74.         in the list are delimited by dots eg. bak.tmp would copy the files
  75.         ending with ".bak" or ".tmp".
  76.     -r
  77.         This option is only useful when the "-a" option has been specified.
  78.         The argument {size} (Kbytes) specifies how large an archive may
  79.         become. Any files larger than the specified size will be skipped, so
  80.         the algorithms do not try to estimate the compression rate, but are
  81.         rather conservative in their assumptions. Also, it assumes that an
  82.         archive may be duplicated on the destination drive, so it may be that
  83.         you end up with archives 50% smaller if free space on the destination
  84.         media is scarce. The algorithm, being conservative, in this way
  85.         ensures that no "out of memory" problems occurs and that archives
  86.         won't become larger than the specified size, provided that, if for
  87.         instance compression is performed, an archived file is not larger than
  88.         it was originally. Normally archived files will be significantly
  89.         smaller.
  90.     -s
  91.         This gives you a report on how much memory is needed in order to
  92.         perform a backup. It does not need a {destination} argument.
  93.     -t
  94.         Normally files copied to the destination media will inherit the date &
  95.         time stamp from the original. This option overrides this by stamping
  96.         files with the date & time when the backup was invoked.
  97.     -v
  98.         verbose mode, normally progress reporting will overwrite itself, but
  99.         with this option it will scroll for every sub-directory found in the
  100.         source path as well as inform you of the free internal memory left in
  101.         your machine, which is useful if you suspect that an archive utility
  102.         is stealing memory which might cause the machine to hang if a large
  103.         filesystem is being searched.
  104.     -x
  105.         This option will exclude suffixes specified by the argument
  106.         {suffixes}. If the list is begun with a dot ("."), files which do not
  107.         have a suffix will also be excluded. Suffixes in this list are
  108.         delimited by dots eg. bak.tmp would exclude files foo.bak and foo.tmp
  109.  
  110. LIST FORMAT
  111.     The {format} argument used whenever the "-l" option is specified defines
  112.     what the list is to be composed by:
  113.  
  114.     a   file attributes     (4 character number)
  115.     d   file modify date    (6 characters eg. 910730)
  116.     f   filename            (path + node + suffix)
  117.     n   node                (node + suffix excluding path)
  118.     p   path                (path to file)
  119.     s   size of file        (number)
  120.     t   file modify time    (6 characters eg. 235700)
  121.     u   unix modify time    (seconds since 1 Jan 1970)
  122.     x   default list        (same as -f)
  123.  
  124. ARCHIVE UTILITIES
  125.     When using the Archive utility option you have to specify the filename of
  126.     the archive utility, with the {utility} argument. You also have to specify
  127.     the way dbackup should call the archive utility, which is specified with
  128.     the {line} argument. When specifying this tilde "~" is used as a special
  129.     formating sequence, which is listed below:
  130.         ~a<xxx>
  131.             expands to the runtime archive name with a suffix defined by {xxx}
  132.             eg. "~alzh" would expand to an archive filename with a suffix
  133.             ".LZH". {xxx} must not contain a leading dot.
  134.         ~f  expands to the files to be backup:ed
  135.         ~~  expands to a single tilde (~)
  136.  
  137.     Please note that the {line} argument must be a single one which means that
  138.     if it contains spaces, the argument must be within quotes.
  139.  
  140.     Arhive filenames names will be in the form:
  141.         DBAK????.xxx
  142.     where ???? denote a decimal sequence number. The sequence number will
  143.     usually starts at 0001 or the next sequence number found in the
  144.     corresponding sub-directory on the destination media of the source
  145.     sub-directory.
  146.  
  147.     Normally when an archive utility error occurs, dbackup will report that
  148.     files have been skipped due to an archive error and the archive flag of
  149.     these files will be untouched. If such an error occurs it is necessary to
  150.     run dbackup again, or otherwise the backup will not be complete.
  151.  
  152.     Since some archive utilities may introduce errors in a previous archive
  153.     when an error occurs when it is trying to add files, I decided that if you
  154.     had instructed dbackup to do a FULL BACKUP the sequence number will be
  155.     increased between every call to the archive utility. This means that this
  156.     problem will not occur during such sessions, but they still can happen if
  157.     you're doing INCREMENTAL BACKUP.
  158.  
  159.     Below I list some {line} arguments for some of the common archive
  160.     utilities in use:
  161.         zoo   V2.1:     "ah: ~azoo ~f"
  162.         lharc V2.01b:   "a -a+ ~alzh ~f"
  163.  
  164.     Since ARC doesn't like hidden or system files it is not possible to use
  165.     this utility. This problem also exists with some versions of LHarc. I also
  166.     recommend users of LHarc V2.01b to restrict sizes of archives to below
  167.     800Kbytes or so, because when I was testing this utility with dbackup I
  168.     found that LHarc V2.01b suddenly doubled the size of an archive when it
  169.     reached the 1Mbyte mark. When using dbackup with "-r720", though, I did
  170.     not encounter this problem.
  171.  
  172. RESTRICTED LICENCE
  173.     See the "LICENCE" file for details
  174.  
  175. BUGS
  176.     When using dbackup to copy files it doesn't try to copy as much as
  177.     possible to a disk before it asks the user to swap disks, which means that
  178.     you probably have to cycle through disks whenever prompted to swap disks.
  179.     Users who want to store backups on 720 Kbyte disks are therefore
  180.     recommended to use a dedicated floppy disk backup program eg. Turtle.
  181.     This problem is not present when using the "-a" option, though.
  182.  
  183.     If you plan to use this program with the "-a" option I recommend that you
  184.     use "-x" to exclude all files with suffixes known to indicate compressed
  185.     archives ie. ".ARC", ".LZH" etc and with a second pass use the "-o" with
  186.     the same list to copy the files. This will speedup the backup process
  187.     considerably! Also, when about to do a FULL BACKUP, it is probably best to
  188.     "-m" mark source files before backing them up so that if a fatal error
  189.     occurs you can simply re-start the process, otherwise it would be rather
  190.     difficult to know which files were archived and which were not.
  191.  
  192. AUTHOR
  193.     Andrew Olausson, Gothenburg, Sweden
  194.     FIDONET:    2:203/203.2
  195.     INTERNET:    dxper@dtek.chalmers.se
  196.     INTERNET:   pa-ola@proxxi.se
  197.  
  198.  
  199.